/*
 * Copyright 2004-2005 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.sf.cindy;

/**
 * Event generator. It's just generate event, Session implementations 
 * should ignore the events they don't understand. 
 * 
 * <pre>
 * 
 *     +----->---->-----+
 *     |                |    Event
 *     ^ EventGenerator v----------->Session.onEvent()
 *     |                |
 *     +-----<----<-----+
 * 
 * </pre>
 *  
 * @author Roger Chen
 */
public interface EventGenerator {

    /**
     * Judge current EventGenerator is started.
     * 
     * @return
     * 		current EventGenerator is started
     */
    public boolean isStarted();

    /**
     * Start EventGenerator.
     */
    public void start();

    /**
     * Close EventGenerator.
     * 
     * @deprecated replaced by stop().
     */
    public void close();

    /**
     * Stop EventGenerator.
     */
    public void stop();
}